

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Voice Kit overview &mdash; AIY Projects 2018-11-16 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/doctools.js"></script>
        <script src="_static/language_data.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="aiy.assistant" href="aiy.assistant.html" />
    <link rel="prev" title="aiy.vision.models" href="aiy.vision.models.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="index.html" class="icon icon-home"> AIY Projects
          

          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Common APIs</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="aiy.board.html">aiy.board</a></li>
<li class="toctree-l1"><a class="reference internal" href="aiy.leds.html">aiy.leds</a></li>
<li class="toctree-l1"><a class="reference internal" href="aiy.pins.html">aiy.pins</a></li>
</ul>
<p class="caption"><span class="caption-text">Vision Kit APIs</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="vision.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="aiy.toneplayer.html">aiy.toneplayer</a></li>
<li class="toctree-l1"><a class="reference internal" href="aiy.trackplayer.html">aiy.trackplayer</a></li>
<li class="toctree-l1"><a class="reference internal" href="aiy.vision.annotator.html">aiy.vision.annotator</a></li>
<li class="toctree-l1"><a class="reference internal" href="aiy.vision.inference.html">aiy.vision.inference</a></li>
<li class="toctree-l1"><a class="reference internal" href="aiy.vision.models.html">aiy.vision.models</a></li>
</ul>
<p class="caption"><span class="caption-text">Voice Kit APIs</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#software">Software</a></li>
<li class="toctree-l2"><a class="reference internal" href="#voice-bonnet-voice-kit-v2">Voice Bonnet (Voice Kit V2)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#hardware">Hardware</a></li>
<li class="toctree-l3"><a class="reference internal" href="#drivers">Drivers</a></li>
<li class="toctree-l3"><a class="reference internal" href="#pinout-40-pin-header">Pinout (40-pin header)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#voice-hat-voice-kit-v1">Voice HAT (Voice Kit V1)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id1">Hardware</a></li>
<li class="toctree-l3"><a class="reference internal" href="#schematics">Schematics</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id2">Drivers</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id3">Pinout (40-pin header)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#troubleshooting">Troubleshooting</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="aiy.assistant.html">aiy.assistant</a></li>
<li class="toctree-l1"><a class="reference internal" href="aiy.cloudspeech.html">aiy.cloudspeech</a></li>
<li class="toctree-l1"><a class="reference internal" href="aiy.voice.audio.html">aiy.voice.audio</a></li>
<li class="toctree-l1"><a class="reference internal" href="aiy.voice.tts.html">aiy.voice.tts</a></li>
</ul>
<p class="caption"><span class="caption-text">Other docs</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://github.com/google/aiyprojects-raspbian">Source code (GitHub)</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/google/aiyprojects-raspbian/blob/aiyprojects/CHANGES.md">Change log (GitHub)</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/google/aiyprojects-raspbian/blob/aiyprojects/HACKING.md">Software setup (GitHub)</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/google/aiyprojects-raspbian/blob/aiyprojects/CONTRIBUTING.md">Contribution guide (GitHub)</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">AIY Projects</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>Voice Kit overview</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/voice.md.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="voice-kit-overview">
<h1>Voice Kit overview<a class="headerlink" href="#voice-kit-overview" title="Permalink to this headline">¶</a></h1>
<img src="_static/images/voice-kit.png" class="attempt-right" alt="" width="200"/><p>The AIY Voice Kit is a do-it-yourself intelligent speaker built with a
Raspberry Pi and the Voice Bonnet (or Voice HAT if using the V1 Voice Kit).</p>
<p>After you assemble the kit and run the included demos,
you can extend the kit with your own software and hardware.</p>
<p>Also see the <a class="reference external" href="https://aiyprojects.withgoogle.com/voice/">Voice Kit assembly guide</a>.</p>
<div class="section" id="software">
<h2>Software<a class="headerlink" href="#software" title="Permalink to this headline">¶</a></h2>
<p>To interact with the Google Assistant, convert speech to text, and perform other
actions with the Voice Kit, the system image includes Python library with the
following modules:</p>
<ul class="simple">
<li><p><a class="reference external" href="aiy.assistant.html"><code class="docutils literal notranslate"><span class="pre">aiy.assistant</span></code></a>:
A collection of modules that simplify interaction with the Google Assistant API.</p></li>
<li><p><a class="reference external" href="aiy.cloudspeech.html"><code class="docutils literal notranslate"><span class="pre">aiy.cloudspeech</span></code></a>:
APIs to simplify interaction with the Google Cloud Speech-to-Text service.</p></li>
<li><p><a class="reference external" href="aiy.voice.audio.html"><code class="docutils literal notranslate"><span class="pre">aiy.voice.audio</span></code></a>:
APIs to record and play audio files.</p></li>
<li><p><a class="reference external" href="aiy.voice.tts.html"><code class="docutils literal notranslate"><span class="pre">aiy.voice.tts</span></code></a>:
An API that performs text-to-speech.</p></li>
<li><p><a class="reference external" href="aiy.board.html"><code class="docutils literal notranslate"><span class="pre">aiy.board</span></code></a>:
APIs to use the button that’s attached to the Voice Bonnet’s button connector.</p></li>
<li><p><a class="reference external" href="aiy.leds.html"><code class="docutils literal notranslate"><span class="pre">aiy.leds</span></code></a>:
APIs to control certain LEDs, such as the LEDs in the button and the privacy
LED.</p></li>
<li><p><a class="reference external" href="aiy.pins.html"><code class="docutils literal notranslate"><span class="pre">aiy.pins</span></code></a>:
Pin definitions for the bonnet’s extra GPIO pins, for use with gpiozero.</p></li>
</ul>
</div>
<div class="section" id="voice-bonnet-voice-kit-v2">
<h2>Voice Bonnet (Voice Kit V2)<a class="headerlink" href="#voice-bonnet-voice-kit-v2" title="Permalink to this headline">¶</a></h2>
<div class="section" id="hardware">
<h3>Hardware<a class="headerlink" href="#hardware" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p>Audio Codec: <code class="docutils literal notranslate"><span class="pre">ALC5645</span></code> [I²C address: <code class="docutils literal notranslate"><span class="pre">0x1A</span></code>]</p></li>
<li><p>MCU: <code class="docutils literal notranslate"><span class="pre">ATSAMD09D14</span></code> [I²C address: <code class="docutils literal notranslate"><span class="pre">0x52</span></code>]</p></li>
<li><p>LED Driver: <code class="docutils literal notranslate"><span class="pre">KTD2027B</span></code> [I²C address: <code class="docutils literal notranslate"><span class="pre">0x31</span></code>]</p></li>
<li><p>Crypto (optional): <code class="docutils literal notranslate"><span class="pre">ATECC608A</span></code> [I²C address: <code class="docutils literal notranslate"><span class="pre">0x62</span></code>]</p></li>
<li><p>Microphone: <code class="docutils literal notranslate"><span class="pre">SPH1642HT5H-1</span></code> x 2</p></li>
</ul>
</div>
<div class="section" id="drivers">
<h3>Drivers<a class="headerlink" href="#drivers" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p>MCU driver: <code class="docutils literal notranslate"><span class="pre">modinfo</span> <span class="pre">aiy-io-i2c</span></code></p></li>
<li><p>MCU PWM driver: <code class="docutils literal notranslate"><span class="pre">modinfo</span> <span class="pre">pwm-aiy-io</span></code></p></li>
<li><p>MCU GPIO driver: <code class="docutils literal notranslate"><span class="pre">modinfo</span> <span class="pre">gpio-aiy-io</span></code></p></li>
<li><p>MCU ADC driver: <code class="docutils literal notranslate"><span class="pre">modinfo</span> <span class="pre">aiy-adc</span></code></p></li>
<li><p>LED driver: <code class="docutils literal notranslate"><span class="pre">modinfo</span> <span class="pre">leds-ktd202x</span></code></p></li>
<li><p>Software PWM driver for buzzer: <code class="docutils literal notranslate"><span class="pre">modinfo</span> <span class="pre">pwm-soft</span></code></p></li>
<li><p>Sound drivers: <code class="docutils literal notranslate"><span class="pre">modinfo</span> <span class="pre">rl6231</span> <span class="pre">rt5645</span> <span class="pre">snd_aiy_voicebonnet</span></code></p></li>
</ul>
</div>
<div class="section" id="pinout-40-pin-header">
<h3>Pinout (40-pin header)<a class="headerlink" href="#pinout-40-pin-header" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>       <span class="mf">3.3</span><span class="n">V</span> <span class="o">--&gt;</span> <span class="mi">1</span>    <span class="mi">2</span> <span class="o">&lt;--</span> <span class="mi">5</span><span class="n">V</span>
                <span class="mi">3</span>    <span class="mi">4</span> <span class="o">&lt;--</span> <span class="mi">5</span><span class="n">V</span>
                <span class="mi">5</span>    <span class="mi">6</span> <span class="o">&lt;--</span> <span class="n">GND</span>
                <span class="mi">7</span>    <span class="mi">8</span>
        <span class="n">GND</span> <span class="o">--&gt;</span> <span class="mi">9</span>   <span class="mi">10</span>
                <span class="mi">11</span>  <span class="mi">12</span> <span class="o">&lt;--</span> <span class="n">I2S_BCLK</span>
                <span class="mi">13</span>  <span class="mi">14</span> <span class="o">&lt;--</span> <span class="n">GND</span>
                <span class="mi">15</span>  <span class="mi">16</span> <span class="o">&lt;--</span> <span class="n">BUTTON_GPIO</span> <span class="p">(</span><span class="n">GPIO_23</span><span class="p">)</span>
       <span class="mf">3.3</span><span class="n">V</span> <span class="o">--&gt;</span> <span class="mi">17</span>  <span class="mi">18</span>
                <span class="mi">19</span>  <span class="mi">20</span> <span class="o">&lt;--</span> <span class="n">GND</span>
                <span class="mi">21</span>  <span class="mi">22</span> <span class="o">&lt;--</span> <span class="n">LED_GPIO</span> <span class="p">(</span><span class="n">GPIO_25</span><span class="p">)</span>
                <span class="mi">23</span>  <span class="mi">24</span>
        <span class="n">GND</span> <span class="o">--&gt;</span> <span class="mi">25</span>  <span class="mi">26</span>
     <span class="n">ID_SDA</span> <span class="o">--&gt;</span> <span class="mi">27</span>  <span class="mi">28</span> <span class="o">&lt;--</span> <span class="n">ID_SCL</span>
                <span class="mi">29</span>  <span class="mi">30</span> <span class="o">&lt;--</span> <span class="n">GND</span>
                <span class="mi">31</span>  <span class="mi">32</span>
                <span class="mi">33</span>  <span class="mi">34</span> <span class="o">&lt;--</span> <span class="n">GND</span>
  <span class="n">I2S_LRCLK</span> <span class="o">--&gt;</span> <span class="mi">35</span>  <span class="mi">36</span> <span class="o">&lt;--</span> <span class="n">AMP_ENABLE</span>
                <span class="mi">37</span>  <span class="mi">38</span> <span class="o">&lt;--</span> <span class="n">I2S_DIN</span>
        <span class="n">GND</span> <span class="o">--&gt;</span> <span class="mi">39</span>  <span class="mi">40</span> <span class="o">&lt;--</span> <span class="n">I2S_DOUT</span>
</pre></div>
</div>
<p>Also see the <a class="reference external" href="https://pinout.xyz/pinout/aiy_voice_bonnet">Voice Bonnet on pinout.xyz</a>.</p>
</div>
</div>
<div class="section" id="voice-hat-voice-kit-v1">
<h2>Voice HAT (Voice Kit V1)<a class="headerlink" href="#voice-hat-voice-kit-v1" title="Permalink to this headline">¶</a></h2>
<div class="section" id="id1">
<h3>Hardware<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p>Audio Amplifier: <code class="docutils literal notranslate"><span class="pre">MAX98357A</span></code></p></li>
<li><p>Microphone: <code class="docutils literal notranslate"><span class="pre">ICS-43432</span></code> x 2</p></li>
</ul>
</div>
<div class="section" id="schematics">
<h3>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/google/aiyprojects-raspbian/blob/aiyprojects/schematics/voice_hat/voice_hat.pdf">Main Board</a></p></li>
<li><p><a class="reference external" href="https://github.com/google/aiyprojects-raspbian/blob/aiyprojects/schematics/voice_hat/voice_hat_mic.pdf">Microphone Board</a></p></li>
</ul>
</div>
<div class="section" id="id2">
<h3>Drivers<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/raspberrypi/linux/blob/rpi-4.14.y/sound/soc/bcm/googlevoicehat-codec.c">googlevoicehat-codec.c</a></p></li>
<li><p><a class="reference external" href="https://github.com/raspberrypi/linux/blob/rpi-4.14.y/sound/soc/bcm/googlevoicehat-soundcard.c">googlevoicehat-soundcard.c</a></p></li>
<li><p><a class="reference external" href="https://github.com/raspberrypi/linux/blob/rpi-4.14.y/arch/arm/boot/dts/overlays/googlevoicehat-soundcard-overlay.dts">googlevoicehat-soundcard-overlay.dts</a></p></li>
</ul>
<p>Manual overlay load:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">dtoverlay</span> <span class="n">googlevoicehat</span><span class="o">-</span><span class="n">soundcard</span>
</pre></div>
</div>
<p>Load overlay on each boot:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">echo</span> <span class="s2">&quot;dtoverlay=googlevoicehat-soundcard&quot;</span> <span class="o">|</span> <span class="n">sudo</span> <span class="n">tee</span> <span class="o">-</span><span class="n">a</span> <span class="o">/</span><span class="n">boot</span><span class="o">/</span><span class="n">config</span><span class="o">.</span><span class="n">txt</span>
</pre></div>
</div>
</div>
<div class="section" id="id3">
<h3>Pinout (40-pin header)<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>       <span class="mf">3.3</span><span class="n">V</span> <span class="o">--&gt;</span> <span class="mi">1</span>    <span class="mi">2</span> <span class="o">&lt;--</span> <span class="mi">5</span><span class="n">V</span>
    <span class="n">I2C_SDA</span> <span class="o">--&gt;</span> <span class="mi">3</span>    <span class="mi">4</span> <span class="o">&lt;--</span> <span class="mi">5</span><span class="n">V</span>
    <span class="n">I2C_SCL</span> <span class="o">--&gt;</span> <span class="mi">5</span>    <span class="mi">6</span> <span class="o">&lt;--</span> <span class="n">GND</span>
                <span class="mi">7</span>    <span class="mi">8</span>
        <span class="n">GND</span> <span class="o">--&gt;</span> <span class="mi">9</span>   <span class="mi">10</span>
                <span class="mi">11</span>  <span class="mi">12</span> <span class="o">&lt;--</span> <span class="n">I2S_BCLK</span>
                <span class="mi">13</span>  <span class="mi">14</span> <span class="o">&lt;--</span> <span class="n">GND</span>
                <span class="mi">15</span>  <span class="mi">16</span> <span class="o">&lt;--</span> <span class="n">BUTTON_GPIO</span> <span class="p">(</span><span class="n">GPIO_23</span><span class="p">)</span>
       <span class="mf">3.3</span><span class="n">V</span> <span class="o">--&gt;</span> <span class="mi">17</span>  <span class="mi">18</span>
                <span class="mi">19</span>  <span class="mi">20</span> <span class="o">&lt;--</span> <span class="n">GND</span>
                <span class="mi">21</span>  <span class="mi">22</span>
                <span class="mi">23</span>  <span class="mi">24</span>
        <span class="n">GND</span> <span class="o">--&gt;</span> <span class="mi">25</span>  <span class="mi">26</span>
     <span class="n">ID_SDA</span> <span class="o">--&gt;</span> <span class="mi">27</span>  <span class="mi">28</span> <span class="o">&lt;--</span> <span class="n">ID_SCL</span>
                <span class="mi">29</span>  <span class="mi">30</span> <span class="o">&lt;--</span> <span class="n">GND</span>
                <span class="mi">31</span>  <span class="mi">32</span>
                <span class="mi">33</span>  <span class="mi">34</span> <span class="o">&lt;--</span> <span class="n">GND</span>
  <span class="n">I2S_LRCLK</span> <span class="o">--&gt;</span> <span class="mi">35</span>  <span class="mi">36</span>
                <span class="mi">37</span>  <span class="mi">38</span> <span class="o">&lt;--</span> <span class="n">I2S_DIN</span>
        <span class="n">GND</span> <span class="o">--&gt;</span> <span class="mi">39</span>  <span class="mi">40</span> <span class="o">&lt;--</span> <span class="n">I2S_DOUT</span>
</pre></div>
</div>
<p>Also see the <a class="reference external" href="https://pinout.xyz/pinout/voice_hat">Voice HAT on pinout.xyz</a>.</p>
</div>
</div>
<div class="section" id="troubleshooting">
<h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h2>
<p>See the <a class="reference external" href="https://aiyprojects.withgoogle.com/help#voice-kit">Voice Kit help</a>.</p>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="aiy.assistant.html" class="btn btn-neutral float-right" title="aiy.assistant" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="aiy.vision.models.html" class="btn btn-neutral float-left" title="aiy.vision.models" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2018, Google LLC

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>